Writing Evergreen Comments

$npx mdskill add obra/clank/Writing Evergreen Comments

Write timeless code comments explaining purpose and reasoning.

  • Eliminates confusion from stale historical documentation.
  • Integrates with all programming languages and codebases.
  • Decides content by filtering out temporal context.
  • Delivers clear WHAT and WHY explanations for code.

SKILL.md

.github/skills/Writing Evergreen CommentsView on GitHub ↗

No skill content available yet.

More from obra/clank

SkillDescription
Commenting IntentComment WHY code exists and non-obvious decisions, not WHAT code does (mechanics)
Creating SkillsTDD for process documentation - test with subagents before writing, iterate until bulletproof
Designing Before CodingDesign in pseudocode first, iterate approaches, then translate to code
Domain-Focused NamingName code by what it does in the domain, not how it's implemented or its history
Encapsulating ComplexityHide implementation details behind interfaces - work at domain level (what), not implementation level (how)
Exploring AlternativesTry 2-3 different approaches before implementing - don't settle for first design you think of
Installing Skills SystemFork, clone to ~/.clank, run installer, edit CLAUDE.md
Keeping Routines FocusedEach routine does one thing and does it well - extract when routines have multiple responsibilities
Localizing VariablesDeclare variables in smallest possible scope, initialize close to first use, minimize span and live time
Maintaining Consistent AbstractionsClass interfaces present one cohesive abstraction - don't mix domain logic with serialization, persistence, or unrelated concerns